Content:
- Intro
- Installation
- Censorship
- How to play as a pony
- Differences from another pony-mods
 -- List of improvements
==========================
###   Intro

Sulphur Nimbus contained mlp ponies in the beginning. Later ponies were mostly removed because of copyright reasons.
This mod brings them back while providing improvements and additions.

Game itself: https://oddwarg.itch.io/sulphur-nimbus-hels-elixir
Source code of the game: https://sourceforge.net/projects/sulphur-nimbus-hel-s-elixir/

==========================
###   Installation:

# Base mod
  Open "Base mod" folder and copy content into your game installation with merging.
  After that you can either install optional parts on top of that in the same fashion like you installed base mod, or skip it and read next part.
   
# Optional parts:
  1.  Replace default character (java-mod)
   
 	  # Fair warning:
	     Mod written in pure java-code. Any java-mods from anonymous\untrusted sources could contain viruses.
	     It is sensible to check it's source code for viruses in sulphurreplace.java & npcreplace.java and make sure that binary sulphurreplacement.class & npcreplace.class corresponds it's source code: 
	      * either by de-compiling .class-files, online service will suffice: https://duckduckgo.com/?q=decompile+java+online
		  * or even better, recompiling it yourself with OpenJDK by using following commands (for lazy use just copy folder "mod" and game's Sulphur_Nimbus.jar file into "bin" folder of OpenJDK): 
	          javac.exe -d mod\sulphurreplace -cp Sulphur_Nimbus.jar -source 8 -target 8  mod\sulphurreplace\sulphurreplace\sulphurreplace.java
		      javac.exe -d mod\npcreplace -cp Sulphur_Nimbus.jar -source 8 -target 8  mod\npcreplace\npcreplace\npcreplace.java
			  
	  # Mod description:	
         Normally you need to make it to Melinda to choose your pony-appearance, nor can you do flying tutorial as a pony even after choosing a pony-appearance. 
	     This mod rectifies this by making Rainbow Dash a default character from the very beginning and adds her filly-form to flying tutorials.
	  
	     Folder "mod" should be placed alongside "res" folder in game's root directory.
		 
		 
  2.  Replace npc (java-mod)
      # Mod description:
	    Replaces NPC Melinda, Urd, Oxford with their respective pony-alternatives. 

  3. NSFW detailed female model.
      
      IMPORTANT: 
      Disable censorship!
      
      More detailed backside is the most noticeable difference of this pony-model.
      You can check screenshots in folder of this addon.
      
==========================
###   Censorship
   
   Censorship is ingame option that is enabled by default.
   On standard model it will somewhat hide naughty parts on most ponies, making it more sfw.
   While disabling will make them more anatomically correct. 
   
   On NSFW detailed model censorship breaks it.
	 
==========================
###   How to play as a pony: 
    
# Melinda
   There is an in-game ability to change appearance.
   To do this you need to talk Melinda and choose "Disguise" dialogue-option. (You can reach Melinda after 10-30 minutes of playing in new game.)  
 
   The ability must be unlocked first by completing the game OR editing "stats.txt"-file. 
   To edit "stats.txt"-file: close the game, add "unlock_disguises" (without quotes) in the "metaKeys="  string, don's forget comma.
 
   Example:
     metaKeys = [unlock_flightTutorial1, unlock_demo, unlock_disguises]
	 
# Java-mod
    With Java-mod you start as Rainbow Dash and can play as Filly Rainbow in Tutorials. 
    To choose to another pony you still need Melinda. 
  
# Save-file
	
    If you don't use java-mod, you can start as Rainbow Dash by loading "PonyStart_skip tutorial" save-file.
    If you use java-mod, this save-file is useless to you.
   
    WARNING: It skips intro and first flying tutorial. 
	If you are a new player- start new game and play till the stranding on island. Only after that load that save-file.
	 
	To choose another pony you still need Melinda.  
 

===================================
###   Differences from another pony-mods

  Enhanced "Base mod" is an improved version of an older game-rip-mods that still contained ponies, which were grabbed here:
  https://u.smutty.horse/lzvwgkznpcs.7z 
  https://cdn.discordapp.com/attachments/463889951772114944/792694165477654558/res.zip
  You also can find it in "Source Materials" folder.
  
  #List of improvements:
    v1
	-Added save-file with RD on the first save-point on Island (skips tutorial\prologue).
    -Added java-mod that completely replaces default character with RD: you can play as her even in tutorial stages. Be aware, all java-mods contain exetutables in raw java code.
    -Added option to install nsfw female model with more detailed backside (port of dev's .blender file).
    -Fixed crashing when you try to dash as Rainbow Dash or Rainbow Dad
    -Up-scaled some low-res pony textures
    -Fixed ugly teeth clipping on female model
    -Made it compatible with in-game censorship system: uncensored mode doesn't drew a second butt on your face anymore, while censored mode actually somewhat hides something on standard female model (not on detailed though)
    -Fixed Derpy's derp eyes
    -Fixed backward RD's cutiemark
    -Fixed Rainbow Dad's black wings
    -Kismet uses correct textures now
    v2
    -Fixed rainbow trails on dashing for Rainbow Dash and Rainbow Dad
    -Added textured trails for Twilight and Rarity
    v2.1 and v2.2
    -Reorganized this text-file and folder structure to make it more readable
	v1.3
	-Added option to replace some npc with pony-alternatives: Melinda, Urd, Oxford
	-Replaced some ingame images with pony alternatives (for example rescue-images when you fall to low on Flying Tutorial map)
	-Improved censorship
	-Fixed Fluttershy's and Kismet's(Pony-Urd) hair in uncensored mode
	-Fixed Melinda's teeth clipping
	-Sulphur can be chosen at Melinda even with "replace default charater" java-mod
	-Fixed Rainbow Blaze's backward cutiemark
	-Filly-rainbow in java-mod is hidden as it should be (so installing\removing it will not change disguise in save-files anymore)
    
   Java-mod were made by modifying Oddwarg's "aprilpants" mod.
   Again, it is in "Source Materials". Or here:
   https://oddwarg.com/Permanent/aprilpants.zip
 
  "Detailed model" were made by adapting Oddwarg's original .blender file to game formats.
   You can find .blender files in the "Source Materials" folder.

  "Source Materials" folder also includes game-specific tools to manipulate game-models.
